chore(bestpractices): mirror passing-tier reference + CHANGELOG.md#20
Merged
chore(bestpractices): mirror passing-tier reference + CHANGELOG.md#20
Conversation
…LOG.md
Mirror docsiq's working .bestpractices.json (project 12628 — passing)
so the BadgeApp at bestpractices.dev applies our intent unambiguously:
- Add 7 metadata fields (\$schema, project_id, level: "passing",
badge_url, project_page_url, evidence, audit). Update the lint
workflow's meta allowlist to accept them.
- Add CHANGELOG.md (Keep-a-Changelog 1.1.0) and point
release_notes_justification at it. With CHANGELOG.md present,
BadgeApp's autofill heuristic resolves release_notes to Met
instead of overriding to Unmet.
- Reformat contribution_requirements_justification to prose+URL
combined (matches docsiq's persisted format).
- Drop documentation_basics_* keys + the matching lint entry; docsiq
passes without it and BadgeApp's autofill keeps overriding our
local Met value with Unmet ("No appropriate folder found").
Final: 66 criteria answered (63 Met / 0 Unmet / 3 N/A).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
RandomCodeSpace/docsiq's working.bestpractices.jsonshape (project 12628 — passing) so BadgeApp ingestion applies our intent unambiguouslyCHANGELOG.md(Keep-a-Changelog 1.1.0) and pointrelease_notes_justificationat it; resolves BadgeApp's autofill heuristic forrelease_notesdocumentation_basics_*keys from JSON and the matching lint entry — docsiq passes without it, and BadgeApp's autofill keeps overriding our local Met value with Unmetcontribution_requirements_justificationto prose+URL combined (matches docsiq's persisted format)$schema,project_id,level: "passing",badge_url,project_page_url,evidence,audit); update the lint workflow's meta allowlistFinal: 66 criteria answered (63 Met / 0 Unmet / 3 N/A).
After merge, the maintainer clicks Save (and continue) 🤖 once on https://www.bestpractices.dev/projects/12716/edit to re-ingest. The two criteria where BadgeApp persisted stale text (
contribution_requirements,vulnerability_report_process) may need a one-time manual save on the edit page.Test plan
Best Practices JSON Lintworkflow passes on this PRCIworkflow passes (no Go / UI source changes)in_progresstopassing🤖 Generated with Claude Code